Carbon


GetWindowProxyIcon

Header: MacWindows.h Carbon status: Supported

Obtains a window’s proxy icon.

OSStatus GetWindowProxyIcon (
    WindowRef window, 
    IconRef *outIcon
);
window

A pointer to the window for which you wish to obtain the proxy icon.

outIcon

On input, a pointer to a value of type IconRef. On return, the icon reference identifies the icon currently used for the window’s proxy icon. Your application is responsible for disposing of this icon reference.

function result

A result code.

DISCUSSION

Your application should call the GetWindowProxyIcon function if it needs to obtain an IconRef value for a proxy icon, such as is required for the function SetWindowProxyIcon.

VERSION NOTES

This function is available with Mac OS 8.5 and later.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when WindowsLib 8.5 or later is installed. Exported by CarbonLib 1.0 and later and by WindowsLib 8.5 and later.


© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)